docs: improve readability of API method signatures#2460
Conversation
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. |
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the readability of long object signatures in the documentation by upgrading Sphinx and configuring it to wrap long lines. The changes, including the new CSS for styling and the updated dependencies, are well-implemented and effectively address the issue. The code is clean and I have no concerns.
haakonvt
changed the title
|
That is a lot better (!!) |
|
I also found a way to go from: 
|
|
...to: 
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2460 +/- ##
==========================================
- Coverage 48.87% 48.84% -0.04%
==========================================
Files 191 191
Lines 26156 26156
==========================================
- Hits 12785 12777 -8
- Misses 13371 13379 +8 🚀 New features to boost your workflow:
|
haakonvt
force-pushed
the
docs-linebreaks-in-signatures
branch
from
8e068f0 to
96fe1ad
Compare
haakonvt
changed the title
haakonvt
force-pushed
the
docs-linebreaks-in-signatures
branch
from
96fe1ad to
36cb1f3
Compare
haakonvt
added
waiting-for-risk-review
Co-authored-by: Håkon V. Treider <haakonvt@gmail.com>
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
haakonvt
added
waiting-for-team
Co-authored-by: Håkon V. Treider <haakonvt@gmail.com>
3 participants
Description
In the docs long object signatures are very hard to read. Splitting the arguments of long function signatures on separate lines will greatly help on readablility.
Example of current look:
Example of new look:
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.